[docs] Add docs for env.* JVM and process options#3618
Merged
Conversation
orangeCatDeveloper
force-pushed
the
docs-env-vars
branch
from
July 8, 2026 07:25
99f81f2 to
5e8e941
Compare
orangeCatDeveloper
marked this pull request as draft
July 8, 2026 07:37
orangeCatDeveloper
marked this pull request as ready for review
July 8, 2026 07:37
Contributor
There was a problem hiding this comment.
Pull request overview
Adds missing documentation for env.* launch-environment options used by Fluss distribution startup scripts, improving operator discoverability on the Server Configuration page.
Changes:
- Document JVM-selection and JVM-option keys (
env.java.home,env.java.opts.*) and PID directory (env.pid.dir) in a new Environment section. - Add a cross-reference to existing Logging docs for
env.log.*andenv.stdout-err.redirect-to-fileto avoid duplication.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
orangeCatDeveloper
force-pushed
the
docs-env-vars
branch
from
July 18, 2026 03:41
1588763 to
c1099a6
Compare
luoyuxia
reviewed
Jul 18, 2026
orangeCatDeveloper
force-pushed
the
docs-env-vars
branch
from
July 18, 2026 09:12
c1099a6 to
9dafab0
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Purpose
Linked issue: close #2513
The
env.*options that thebin/startup scripts read fromconf/server.yamlwere undocumented. This adds an Environment section to the Server Configuration page covering the JVM and process-launch options.Brief change log
## Environmentsection tomaintenance/configuration.mddocumenting the options thatbin/config.shreads and applies at process launch:env.java.homeenv.java.opts.allenv.java.opts.coordinator-serverenv.java.opts.tablet-serverenv.pid.direnv.log.*options, to avoid duplication.Not included (from the issue's key list):
env.log.dir/env.log.level/env.log.max/env.stdout-err.redirect-to-file— already documented under Logging.remote.data.dir— already documented in the same page's Common section.env.ssh.optsandzookeeper.heap.mb— currently read into shell variables (FLUSS_SSH_OPTS,ZK_HEAP) but not wired to any behavior in the shipped scripts, so documenting them as functional options would be misleading. Happy to include them if they are intended to work.Tests
Docs-only change. Built the site locally (
build_versioned_docs.sh+docusaurus build); the new cross-reference link resolves and the change adds no broken links.API and Format
No API or storage format changes.
Documentation
This PR is the documentation.